/*
Copyright 2023 The Dapr Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { KeyValueType } from "../KeyValue.type";
import { WorkflowRuntimeStatus } from "./WorkflowRuntimeStatus.type";

/**
 * WorkflowGetResponseType defines the response from a get request for a workflow.
 */
export type WorkflowGetResponseType = {
  /**
   * instanceID is the unique identifier for the workflow instance.
   */
  instanceID: string;

  /**
   * workflowName is the name of the workflow.
   * This is the name of the workflow as defined in the workflow definition.
   */
  workflowName: string;

  /**
   * createdAt is the time the workflow instance was created.
   */
  createdAt: Date;

  /**
   * lastUpdatedAt is the time the workflow instance was last updated.
   */
  lastUpdatedAt: Date;

  /**
   * runtimeStatus is the current status of the workflow instance.
   */
  runtimeStatus: WorkflowRuntimeStatus;

  /**
   * properties is a collection of key/value pairs that are associated with the workflow instance.
   */
  properties: KeyValueType;
};
